Quick Start

Installation

1. Clone the carletonblueprint.github.io repository from GitHub. Ideally, you would use GitHub Desktop to accomplish this.
2. Install dependencies by running npm install in the root directory of the project.
3. Create the .env.local file in the root directory of the project according to this guide: Contentful API Keys.
4. Run the development server by running npm run dev in the root directory of the project.

Blueprint Tip

• If you get weird errors when running npm run start for the first time after switching branches, try deleting the node_modules folder and running npm install again.

Project Organization

Prerequisite Knowledge

• Private Folders in Next.js (tip: app/_assets, app/_components are private folders)
• Route Groups in Next.js (tip: app/(pages) is a route group)

This short 3-minute video explains how the project is organized and how to navigate the codebase.

Notes

This documentation is entirely open source and can be found on our GitHub. At the bottom of each page, click on the "Edit This Page" link to make changes.